Skip to content

[material_ui] Migrate Dialog, AlertDialog, and SimpleDialog API doc snippets to {@example} (batch 12) - #13721

Open
dkwingsmt wants to merge 2 commits into
flutter:mainfrom
dkwingsmt:snippet_material_dialog
Open

dkwingsmt wants to merge 2 commits into
flutter:mainfrom
dkwingsmt:snippet_material_dialog

Conversation

@dkwingsmt

Copy link
Copy Markdown
Contributor

This PR addresses batch 12 of the migration detailed in flutter/flutter#188530 (comment).

Pre-Review Checklist

If you need help, consider asking for advice on the #hackers-new channel on Discord.

Note: The Flutter team is currently trialing the use of Gemini Code Assist for GitHub. Comments from the gemini-code-assist bot should not be taken as authoritative feedback from the Flutter team. If you find its comments useful you can update your code accordingly, but if you are unsure or disagree with the feedback, please feel free to wait for a Flutter team member's review for guidance on which automated comments should be addressed.

Footnotes

  1. Regular contributors who have demonstrated familiarity with the repository guidelines only need to comment if the PR is not auto-exempted by repo tooling. ↩ ↩2

@flutter-dashboard flutter-dashboard Bot added the CICD Run CI/CD label Nov 19, 2026
@github-actions github-actions Bot added p: material_ui triage-design Should be looked at in design triage labels Nov 19, 2026

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request adds new example files and corresponding tests for the AlertDialog, Dialog, SimpleDialog, and SimpleDialogOption components. It also updates the documentation in packages/material_ui/lib/src/dialog.dart to use the {@example} macro for these snippets. Feedback indicates that the file paths in the {@example} tags should be relative to the package root without a leading slash, and suggests adding a mounted check in the SimpleDialog example to ensure safe handling of asynchronous gaps.

/// )
/// ```
///
/// {@example /example/lib/dialog/alert_dialog.snippet.1.dart#body indent=strip}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

The path in the {@example} macro should be relative to the package root and should not start with a leading slash. A leading slash can cause the snippet tool to fail to resolve the file path correctly.

  /// {@example example/lib/dialog/alert_dialog.snippet.1.dart#body indent=strip}

/// child: const Text('Treasury department'),
/// )
/// ```
/// {@example /example/lib/dialog/simple_dialog_option.snippet.0.dart#body indent=strip}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

The path in the {@example} macro should be relative to the package root and should not start with a leading slash. A leading slash can cause the snippet tool to fail to resolve the file path correctly.

/// {@example example/lib/dialog/simple_dialog_option.snippet.0.dart#body indent=strip}

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CICD Run CI/CD p: material_ui triage-design Should be looked at in design triage

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant